Test Studio Storage Service API Documentation
This documentation explains the use of the Test Studio Storage Service API. The Test Studio Storage Service stores all test data produced by a distributed installation of Test Studio. The Storage Service API exposes this data using a RESTful web interface. The API exposes a set of endpoints that correspond to the types of data created by Test Studio. The format for making calls to a specific endpoint is documented in the page for that endpoint.
Applications of the API
The Storage Service API allows developers to access data about the state of their Test Studio test projects and test results. A custom application can then format this information to produce reporting in arbitrary formats. This may facilitate reporting in custom formats or in formats compatible with proprietary technologies.
The Storage Service API also exposes calls to add data to the storage service. However, the Storage Service does not validate data added in this manner. We recommend making such calls with caution, since adding data to the service in an improper format may cause unexpected results.
BaseStorage
GET
/BaseStorage
GET basestorage via query. Note that this does NOT currently return attachments.
Returns the ENTIRE document including OID and Metadata, unless fields parameter or header is specified.
You may limit the number of basestorage returned by using the optional query parameter or header.
When used as a header the format is
Equality is via implication only:
You may limit the number of basestorage returned by using the optional query parameter or header.
When used as a header the format is
Query: { "Data.FieldToCompare" : "Value" }.Equality is via implication only:
{ "field": "value" } and the following operators are supported:$and, $ne, $gt, $lt, $gte, $lteExample operator usage:
Query:{
"Metadata.LastUpdate": {
"$gt": "2012-08-15"
}
}Parameters
/BaseStorage?skip={skip}&take={take}&sortKeys={sortKeys}&schema={schema}&includeDeleted={includeDeleted}&query={query}&fields={fields}
skip
[Int32]
Starting point for paging. Defaults to 0.
take
[Int32]
End point for paging. Defaults to 100.
sortKeys
[String]
Comma seperated list of fields to sort the basestorage result set on. NOTE: Not implemented.
schema
[String]
Identifier for the object being stored.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted basestorage. Defaults to true.
query
[String]
Filter for basestorage result set. Query format:
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields
[String]
Filter to limit the fields returned on a basestorage. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata
Returns
An array of IStorageDataEntity objects
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of basestorage"
}HTTP Status
Reason
200
OK
400
Bad Request: Invalid arguments supplied.
GET
/BaseStorage/{id}
GET a basestorage by id. This will return attachments.
Retrieves the full basestorage including attachments. When attachments are present the response's content type will be multipart/mixed.
Parameters
/BaseStorage/{id}?includeDeleted={includeDeleted}
id
[String]
required
The identifier of the basestorage being retreived
includeDeleted
[Boolean]
Optional boolean indicating wheter to fetch deleted basestorage. Defaults to true.
Returns
IStorageDataEntity object:
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of basestorage"
}HTTP Status
Reason
200
OK
400
Bad Request: id parameter not supplied.
404
Not Found: basestorage does not exist.
410
Gone: basestorage is deleted when request supplies includeDeleted parameter as false.
POST
/BaseStorage
Add a new basestorage (or basestorage) to the basestorage collection
The request body should contain the json representation of the basestorage or basestorage to add.
Example:
Attachments can be re-used (associated with multiple Json basestorage). When adding an attachment to a basestorage the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Key" : "NewValue", "Key2" : "NewValue2", ... } Note: This handles "bulk upload" of several basestorage with any number of associated attachments.Attachments can be re-used (associated with multiple Json basestorage). When adding an attachment to a basestorage the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of basestorage }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/BaseStorage?schema={schema}&name={name}&parentId={parentId}
schema
[String]
Optional identifier for the basestorage being stored. This will be stored in the Metadata object of the created basestorage.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
name
[String]
Allows the inclusion of a name for metadata tagging (and Activity creation)
parentId
[String]
Allows the inclusion of a Parent Id for metadata tagging (and Activity creation)
Returns
201 Created. The response body will contain the created basestorage and the custom added Header contains the Meadata for the newly created basestorage in json format.
Example Added custom header:
Example Added custom header:
Added:{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
201
Created: basestorage succesfully created. Added Header contains the metadata for the newly created basestorage.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT
/BaseStorage/{id}
Update a basestorage in the basestorage collection
The request body should contain the json representation of the basestorage to update.
Example:
Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a basestorage the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Data.Key" : "NewValue", "Data.Key2" : "NewValue2" }Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a basestorage the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of basestorage }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/BaseStorage/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the basestorage to update
lastUpdate
[String]
required
The timestamp of last update for this basestorage.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK. The response body contains the updated basestorage and the custom Updated header contains the updated basestorage metadata.
Example custom Updated header:
Example custom Updated header:
Updated:{
"UpdatedDocuments": [
{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:14:16.0482808Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}
]
}HTTP Status
Reason
200
OK. Updated header will contain metadata for updated basestorage.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: basestorage has been previously deleted.
409
Conflict: lastUpdate does not match basestorage's last updated timestamp.
DELETE
/BaseStorage/{id}
Remove a basestorage from the basestorage collection
Note: this does not perform a hard delete. The basestorage is tombstoned in the collection.
Parameters
/BaseStorage/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the basestorage to remove.
lastUpdate
[String]
required
The timestamp of last update for this basestorage.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: basestorage has been previously deleted.
409
Conflict: lastUpdate does not match basestorage's last updated timestamp.
Counters
Counters Telerik.TestStudio.Load.Common.CounterTransport collection.
Counters are containers for the indivual datapoints collected during a performance test.
Example:
Counters are containers for the indivual datapoints collected during a performance test.
Example:
{
"Data": {
"Id": "string",
"ResultId": "string",
"CounterTypeId": "string"
},
"MetaData": "MetaData object"
}
GET
/Counters
GET counters via query. Note that this does NOT currently return attachments.
Returns the ENTIRE document including OID and Metadata, unless fields parameter or header is specified.
You may limit the number of counters returned by using the optional query parameter or header.
When used as a header the format is
Equality is via implication only:
You may limit the number of counters returned by using the optional query parameter or header.
When used as a header the format is
Query: { "Data.FieldToCompare" : "Value" }.Equality is via implication only:
{ "field": "value" } and the following operators are supported:$and, $ne, $gt, $lt, $gte, $lteExample operator usage:
Query:{
"Metadata.LastUpdate": {
"$gt": "2012-08-15"
}
}Parameters
/Counters?skip={skip}&take={take}&sortKeys={sortKeys}&schema={schema}&includeDeleted={includeDeleted}&query={query}&fields={fields}
skip
[Int32]
Starting point for paging. Defaults to 0.
take
[Int32]
End point for paging. Defaults to 100.
sortKeys
[String]
Comma seperated list of fields to sort the counter result set on. NOTE: Not implemented.
schema
[String]
Identifier for the object being stored.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted counters. Defaults to true.
query
[String]
Filter for counter result set. Query format:
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields
[String]
Filter to limit the fields returned on a counter. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata
Returns
An array of IStorageDataEntity objects
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of counter"
}HTTP Status
Reason
200
OK
400
Bad Request: Invalid arguments supplied.
GET
/Counters/{id}
GET a counter by id. This will return attachments.
Retrieves the full counter including attachments. When attachments are present the response's content type will be multipart/mixed.
Parameters
/Counters/{id}?includeDeleted={includeDeleted}
id
[String]
required
The identifier of the counter being retreived
includeDeleted
[Boolean]
Optional boolean indicating wheter to fetch deleted counters. Defaults to true.
Returns
IStorageDataEntity object:
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of counter"
}HTTP Status
Reason
200
OK
400
Bad Request: id parameter not supplied.
404
Not Found: counter does not exist.
410
Gone: counter is deleted when request supplies includeDeleted parameter as false.
POST
/Counters
Add a new counter (or counters) to the counter collection
The request body should contain the json representation of the counter or counters to add.
Example:
Attachments can be re-used (associated with multiple Json counters). When adding an attachment to a counter the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Key" : "NewValue", "Key2" : "NewValue2", ... } Note: This handles "bulk upload" of several counters with any number of associated attachments.Attachments can be re-used (associated with multiple Json counters). When adding an attachment to a counter the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of counter }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/Counters?schema={schema}&name={name}&parentId={parentId}
schema
[String]
Optional identifier for the counter being stored. This will be stored in the Metadata object of the created counter.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
name
[String]
Allows the inclusion of a name for metadata tagging (and Activity creation)
parentId
[String]
Allows the inclusion of a Parent Id for metadata tagging (and Activity creation)
Returns
201 Created. The response body will contain the created counter and the custom added Header contains the Meadata for the newly created counter in json format.
Example Added custom header:
Example Added custom header:
Added:{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
201
Created: counter succesfully created. Added Header contains the metadata for the newly created counter.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT
/Counters/{id}
Update a counter in the counter collection
The request body should contain the json representation of the counter to update.
Example:
Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a counter the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Data.Key" : "NewValue", "Data.Key2" : "NewValue2" }Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a counter the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of counter }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/Counters/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the counter to update
lastUpdate
[String]
required
The timestamp of last update for this counter.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK. The response body contains the updated counter and the custom Updated header contains the updated counter metadata.
Example custom Updated header:
Example custom Updated header:
Updated:{
"UpdatedDocuments": [
{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:14:16.0482808Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}
]
}HTTP Status
Reason
200
OK. Updated header will contain metadata for updated counter.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: counter has been previously deleted.
409
Conflict: lastUpdate does not match counter's last updated timestamp.
DELETE
/Counters/{id}
Remove a counter from the counter collection
Note: this does not perform a hard delete. The counter is tombstoned in the collection.
Parameters
/Counters/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the counter to remove.
lastUpdate
[String]
required
The timestamp of last update for this counter.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: counter has been previously deleted.
409
Conflict: lastUpdate does not match counter's last updated timestamp.
Comments
Comments Collection.
Comments are a part of the feedback mechanism when testing through the IOS application and can be viewed and added through the web portal.
Comments are a part of the feedback mechanism when testing through the IOS application and can be viewed and added through the web portal.
GET
/Comments
GET comments via query. Note that this does NOT currently return attachments.
Returns the ENTIRE document including OID and Metadata, unless fields parameter or header is specified.
You may limit the number of comments returned by using the optional query parameter or header.
When used as a header the format is
Equality is via implication only:
You may limit the number of comments returned by using the optional query parameter or header.
When used as a header the format is
Query: { "Data.FieldToCompare" : "Value" }.Equality is via implication only:
{ "field": "value" } and the following operators are supported:$and, $ne, $gt, $lt, $gte, $lteExample operator usage:
Query:{
"Metadata.LastUpdate": {
"$gt": "2012-08-15"
}
}Parameters
/Comments?skip={skip}&take={take}&sortKeys={sortKeys}&schema={schema}&includeDeleted={includeDeleted}&query={query}&fields={fields}
skip
[Int32]
Starting point for paging. Defaults to 0.
take
[Int32]
End point for paging. Defaults to 100.
sortKeys
[String]
Comma seperated list of fields to sort the comment result set on. NOTE: Not implemented.
schema
[String]
Identifier for the object being stored.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted comments. Defaults to true.
query
[String]
Filter for comment result set. Query format:
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields
[String]
Filter to limit the fields returned on a comment. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata
Returns
An array of IStorageDataEntity objects
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of comment"
}HTTP Status
Reason
200
OK
400
Bad Request: Invalid arguments supplied.
GET
/Comments/{id}
GET a comment by id. This will return attachments.
Retrieves the full comment including attachments. When attachments are present the response's content type will be multipart/mixed.
Parameters
/Comments/{id}?includeDeleted={includeDeleted}
id
[String]
required
The identifier of the comment being retreived
includeDeleted
[Boolean]
Optional boolean indicating wheter to fetch deleted comments. Defaults to true.
Returns
IStorageDataEntity object:
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of comment"
}HTTP Status
Reason
200
OK
400
Bad Request: id parameter not supplied.
404
Not Found: comment does not exist.
410
Gone: comment is deleted when request supplies includeDeleted parameter as false.
POST
/Comments
Add a new comment (or comments) to the comment collection
The request body should contain the json representation of the comment or comments to add.
Example:
Attachments can be re-used (associated with multiple Json comments). When adding an attachment to a comment the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Key" : "NewValue", "Key2" : "NewValue2", ... } Note: This handles "bulk upload" of several comments with any number of associated attachments.Attachments can be re-used (associated with multiple Json comments). When adding an attachment to a comment the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of comment }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/Comments?schema={schema}&name={name}&parentId={parentId}
schema
[String]
Optional identifier for the comment being stored. This will be stored in the Metadata object of the created comment.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
name
[String]
Allows the inclusion of a name for metadata tagging (and Activity creation)
parentId
[String]
Allows the inclusion of a Parent Id for metadata tagging (and Activity creation)
Returns
201 Created. The response body will contain the created comment and the custom added Header contains the Meadata for the newly created comment in json format.
Example Added custom header:
Example Added custom header:
Added:{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
201
Created: comment succesfully created. Added Header contains the metadata for the newly created comment.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT
/Comments/{id}
Update a comment in the comment collection
The request body should contain the json representation of the comment to update.
Example:
Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a comment the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Data.Key" : "NewValue", "Data.Key2" : "NewValue2" }Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a comment the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of comment }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/Comments/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the comment to update
lastUpdate
[String]
required
The timestamp of last update for this comment.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK. The response body contains the updated comment and the custom Updated header contains the updated comment metadata.
Example custom Updated header:
Example custom Updated header:
Updated:{
"UpdatedDocuments": [
{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:14:16.0482808Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}
]
}HTTP Status
Reason
200
OK. Updated header will contain metadata for updated comment.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: comment has been previously deleted.
409
Conflict: lastUpdate does not match comment's last updated timestamp.
DELETE
/Comments/{id}
Remove a comment from the comment collection
Note: this does not perform a hard delete. The comment is tombstoned in the collection.
Parameters
/Comments/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the comment to remove.
lastUpdate
[String]
required
The timestamp of last update for this comment.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: comment has been previously deleted.
409
Conflict: lastUpdate does not match comment's last updated timestamp.
CounterTypes
CounterTypes Telerik.TestStudio.Load.Common.CounterTypeTransport collection.
Counter Type contains the description for the perfomance counter collected during a performance test.
Example:
Counter Type contains the description for the perfomance counter collected during a performance test.
Example:
{
"Data": {
"Id": "string",
"Name": "string",
"Description": "string",
"PluginGuid": "string"
},
"MetaData": "MetaData object"
}
GET
/CounterTypes
GET countertypes via query. Note that this does NOT currently return attachments.
Returns the ENTIRE document including OID and Metadata, unless fields parameter or header is specified.
You may limit the number of countertypes returned by using the optional query parameter or header.
When used as a header the format is
Equality is via implication only:
You may limit the number of countertypes returned by using the optional query parameter or header.
When used as a header the format is
Query: { "Data.FieldToCompare" : "Value" }.Equality is via implication only:
{ "field": "value" } and the following operators are supported:$and, $ne, $gt, $lt, $gte, $lteExample operator usage:
Query:{
"Metadata.LastUpdate": {
"$gt": "2012-08-15"
}
}Parameters
/CounterTypes?skip={skip}&take={take}&sortKeys={sortKeys}&schema={schema}&includeDeleted={includeDeleted}&query={query}&fields={fields}
skip
[Int32]
Starting point for paging. Defaults to 0.
take
[Int32]
End point for paging. Defaults to 100.
sortKeys
[String]
Comma seperated list of fields to sort the countertype result set on. NOTE: Not implemented.
schema
[String]
Identifier for the object being stored.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted countertypes. Defaults to true.
query
[String]
Filter for countertype result set. Query format:
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields
[String]
Filter to limit the fields returned on a countertype. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata
Returns
An array of IStorageDataEntity objects
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of countertype"
}HTTP Status
Reason
200
OK
400
Bad Request: Invalid arguments supplied.
GET
/CounterTypes/{id}
GET a countertype by id. This will return attachments.
Retrieves the full countertype including attachments. When attachments are present the response's content type will be multipart/mixed.
Parameters
/CounterTypes/{id}?includeDeleted={includeDeleted}
id
[String]
required
The identifier of the countertype being retreived
includeDeleted
[Boolean]
Optional boolean indicating wheter to fetch deleted countertypes. Defaults to true.
Returns
IStorageDataEntity object:
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of countertype"
}HTTP Status
Reason
200
OK
400
Bad Request: id parameter not supplied.
404
Not Found: countertype does not exist.
410
Gone: countertype is deleted when request supplies includeDeleted parameter as false.
POST
/CounterTypes
Add a new countertype (or countertypes) to the countertype collection
The request body should contain the json representation of the countertype or countertypes to add.
Example:
Attachments can be re-used (associated with multiple Json countertypes). When adding an attachment to a countertype the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Key" : "NewValue", "Key2" : "NewValue2", ... } Note: This handles "bulk upload" of several countertypes with any number of associated attachments.Attachments can be re-used (associated with multiple Json countertypes). When adding an attachment to a countertype the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of countertype }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/CounterTypes?schema={schema}&name={name}&parentId={parentId}
schema
[String]
Optional identifier for the countertype being stored. This will be stored in the Metadata object of the created countertype.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
name
[String]
Allows the inclusion of a name for metadata tagging (and Activity creation)
parentId
[String]
Allows the inclusion of a Parent Id for metadata tagging (and Activity creation)
Returns
201 Created. The response body will contain the created countertype and the custom added Header contains the Meadata for the newly created countertype in json format.
Example Added custom header:
Example Added custom header:
Added:{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
201
Created: countertype succesfully created. Added Header contains the metadata for the newly created countertype.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT
/CounterTypes/{id}
Update a countertype in the countertype collection
The request body should contain the json representation of the countertype to update.
Example:
Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a countertype the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Data.Key" : "NewValue", "Data.Key2" : "NewValue2" }Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a countertype the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of countertype }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/CounterTypes/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the countertype to update
lastUpdate
[String]
required
The timestamp of last update for this countertype.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK. The response body contains the updated countertype and the custom Updated header contains the updated countertype metadata.
Example custom Updated header:
Example custom Updated header:
Updated:{
"UpdatedDocuments": [
{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:14:16.0482808Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}
]
}HTTP Status
Reason
200
OK. Updated header will contain metadata for updated countertype.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: countertype has been previously deleted.
409
Conflict: lastUpdate does not match countertype's last updated timestamp.
DELETE
/CounterTypes/{id}
Remove a countertype from the countertype collection
Note: this does not perform a hard delete. The countertype is tombstoned in the collection.
Parameters
/CounterTypes/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the countertype to remove.
lastUpdate
[String]
required
The timestamp of last update for this countertype.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: countertype has been previously deleted.
409
Conflict: lastUpdate does not match countertype's last updated timestamp.
DataPoints
DataPoints Telerik.TestStudio.Load.Common.DataPointTransport Collection
Contains the individual DataPoints collected during a load test.
Example:
Contains the individual DataPoints collected during a load test.
Example:
{
"Data": {
"Id": "string",
"CounterId": "string",
"Timestamp": "ISO-8601 UTC date string",
"Data": "double",
"PageSpecificMetrics": ""
},
"MetaData": "MetaData object"
}
GET
/DataPoints
GET datapoints via query. Note that this does NOT currently return attachments.
Returns the ENTIRE document including OID and Metadata, unless fields parameter or header is specified.
You may limit the number of datapoints returned by using the optional query parameter or header.
When used as a header the format is
Equality is via implication only:
You may limit the number of datapoints returned by using the optional query parameter or header.
When used as a header the format is
Query: { "Data.FieldToCompare" : "Value" }.Equality is via implication only:
{ "field": "value" } and the following operators are supported:$and, $ne, $gt, $lt, $gte, $lteExample operator usage:
Query:{
"Metadata.LastUpdate": {
"$gt": "2012-08-15"
}
}Parameters
/DataPoints?skip={skip}&take={take}&sortKeys={sortKeys}&schema={schema}&includeDeleted={includeDeleted}&query={query}&fields={fields}
skip
[Int32]
Starting point for paging. Defaults to 0.
take
[Int32]
End point for paging. Defaults to 100.
sortKeys
[String]
Comma seperated list of fields to sort the datapoint result set on. NOTE: Not implemented.
schema
[String]
Identifier for the object being stored.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted datapoints. Defaults to true.
query
[String]
Filter for datapoint result set. Query format:
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields
[String]
Filter to limit the fields returned on a datapoint. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata
Returns
An array of IStorageDataEntity objects
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of datapoint"
}HTTP Status
Reason
200
OK
400
Bad Request: Invalid arguments supplied.
GET
/DataPoints/{id}
GET a datapoint by id. This will return attachments.
Retrieves the full datapoint including attachments. When attachments are present the response's content type will be multipart/mixed.
Parameters
/DataPoints/{id}?includeDeleted={includeDeleted}
id
[String]
required
The identifier of the datapoint being retreived
includeDeleted
[Boolean]
Optional boolean indicating wheter to fetch deleted datapoints. Defaults to true.
Returns
IStorageDataEntity object:
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of datapoint"
}HTTP Status
Reason
200
OK
400
Bad Request: id parameter not supplied.
404
Not Found: datapoint does not exist.
410
Gone: datapoint is deleted when request supplies includeDeleted parameter as false.
POST
/DataPoints
Add a new datapoint (or datapoints) to the datapoint collection
The request body should contain the json representation of the datapoint or datapoints to add.
Example:
Attachments can be re-used (associated with multiple Json datapoints). When adding an attachment to a datapoint the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Key" : "NewValue", "Key2" : "NewValue2", ... } Note: This handles "bulk upload" of several datapoints with any number of associated attachments.Attachments can be re-used (associated with multiple Json datapoints). When adding an attachment to a datapoint the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of datapoint }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/DataPoints?schema={schema}&name={name}&parentId={parentId}
schema
[String]
Optional identifier for the datapoint being stored. This will be stored in the Metadata object of the created datapoint.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
name
[String]
Allows the inclusion of a name for metadata tagging (and Activity creation)
parentId
[String]
Allows the inclusion of a Parent Id for metadata tagging (and Activity creation)
Returns
201 Created. The response body will contain the created datapoint and the custom added Header contains the Meadata for the newly created datapoint in json format.
Example Added custom header:
Example Added custom header:
Added:{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
201
Created: datapoint succesfully created. Added Header contains the metadata for the newly created datapoint.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT
/DataPoints/{id}
Update a datapoint in the datapoint collection
The request body should contain the json representation of the datapoint to update.
Example:
Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a datapoint the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Data.Key" : "NewValue", "Data.Key2" : "NewValue2" }Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a datapoint the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of datapoint }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/DataPoints/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the datapoint to update
lastUpdate
[String]
required
The timestamp of last update for this datapoint.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK. The response body contains the updated datapoint and the custom Updated header contains the updated datapoint metadata.
Example custom Updated header:
Example custom Updated header:
Updated:{
"UpdatedDocuments": [
{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:14:16.0482808Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}
]
}HTTP Status
Reason
200
OK. Updated header will contain metadata for updated datapoint.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: datapoint has been previously deleted.
409
Conflict: lastUpdate does not match datapoint's last updated timestamp.
DELETE
/DataPoints/{id}
Remove a datapoint from the datapoint collection
Note: this does not perform a hard delete. The datapoint is tombstoned in the collection.
Parameters
/DataPoints/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the datapoint to remove.
lastUpdate
[String]
required
The timestamp of last update for this datapoint.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: datapoint has been previously deleted.
409
Conflict: lastUpdate does not match datapoint's last updated timestamp.
CrashReports
Crash Reports collection
Crash reports are collected and stored by the IOS application only. Feedback van be viewed in the web portal.
Crash reports are collected and stored by the IOS application only. Feedback van be viewed in the web portal.
GET
/CrashReports
GET crashreports via query. Note that this does NOT currently return attachments.
Returns the ENTIRE document including OID and Metadata, unless fields parameter or header is specified.
You may limit the number of crashreports returned by using the optional query parameter or header.
When used as a header the format is
Equality is via implication only:
You may limit the number of crashreports returned by using the optional query parameter or header.
When used as a header the format is
Query: { "Data.FieldToCompare" : "Value" }.Equality is via implication only:
{ "field": "value" } and the following operators are supported:$and, $ne, $gt, $lt, $gte, $lteExample operator usage:
Query:{
"Metadata.LastUpdate": {
"$gt": "2012-08-15"
}
}Parameters
/CrashReports?skip={skip}&take={take}&sortKeys={sortKeys}&schema={schema}&includeDeleted={includeDeleted}&query={query}&fields={fields}
skip
[Int32]
Starting point for paging. Defaults to 0.
take
[Int32]
End point for paging. Defaults to 100.
sortKeys
[String]
Comma seperated list of fields to sort the crashreport result set on. NOTE: Not implemented.
schema
[String]
Identifier for the object being stored.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted crashreports. Defaults to true.
query
[String]
Filter for crashreport result set. Query format:
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields
[String]
Filter to limit the fields returned on a crashreport. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata
Returns
An array of IStorageDataEntity objects
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of crashreport"
}HTTP Status
Reason
200
OK
400
Bad Request: Invalid arguments supplied.
GET
/CrashReports/{id}
GET a crashreport by id. This will return attachments.
Retrieves the full crashreport including attachments. When attachments are present the response's content type will be multipart/mixed.
Parameters
/CrashReports/{id}?includeDeleted={includeDeleted}
id
[String]
required
The identifier of the crashreport being retreived
includeDeleted
[Boolean]
Optional boolean indicating wheter to fetch deleted crashreports. Defaults to true.
Returns
IStorageDataEntity object:
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of crashreport"
}HTTP Status
Reason
200
OK
400
Bad Request: id parameter not supplied.
404
Not Found: crashreport does not exist.
410
Gone: crashreport is deleted when request supplies includeDeleted parameter as false.
POST
/CrashReports
Add a new crashreport (or crashreports) to the crashreport collection
The request body should contain the json representation of the crashreport or crashreports to add.
Example:
Attachments can be re-used (associated with multiple Json crashreports). When adding an attachment to a crashreport the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Key" : "NewValue", "Key2" : "NewValue2", ... } Note: This handles "bulk upload" of several crashreports with any number of associated attachments.Attachments can be re-used (associated with multiple Json crashreports). When adding an attachment to a crashreport the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of crashreport }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/CrashReports?schema={schema}&name={name}&parentId={parentId}
schema
[String]
Optional identifier for the crashreport being stored. This will be stored in the Metadata object of the created crashreport.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
name
[String]
Allows the inclusion of a name for metadata tagging (and Activity creation)
parentId
[String]
Allows the inclusion of a Parent Id for metadata tagging (and Activity creation)
Returns
201 Created. The response body will contain the created crashreport and the custom added Header contains the Meadata for the newly created crashreport in json format.
Example Added custom header:
Example Added custom header:
Added:{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
201
Created: crashreport succesfully created. Added Header contains the metadata for the newly created crashreport.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT
/CrashReports/{id}
Update a crashreport in the crashreport collection
The request body should contain the json representation of the crashreport to update.
Example:
Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a crashreport the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Data.Key" : "NewValue", "Data.Key2" : "NewValue2" }Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a crashreport the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of crashreport }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/CrashReports/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the crashreport to update
lastUpdate
[String]
required
The timestamp of last update for this crashreport.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK. The response body contains the updated crashreport and the custom Updated header contains the updated crashreport metadata.
Example custom Updated header:
Example custom Updated header:
Updated:{
"UpdatedDocuments": [
{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:14:16.0482808Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}
]
}HTTP Status
Reason
200
OK. Updated header will contain metadata for updated crashreport.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: crashreport has been previously deleted.
409
Conflict: lastUpdate does not match crashreport's last updated timestamp.
DELETE
/CrashReports/{id}
Remove a crashreport from the crashreport collection
Note: this does not perform a hard delete. The crashreport is tombstoned in the collection.
Parameters
/CrashReports/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the crashreport to remove.
lastUpdate
[String]
required
The timestamp of last update for this crashreport.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: crashreport has been previously deleted.
409
Conflict: lastUpdate does not match crashreport's last updated timestamp.
Goals
Goals Telerik.TestStudio.Load.Common.Goal collection
Goals are part of the definition of a load test.
Example:
Goals are part of the definition of a load test.
Example:
{
"Data": {
"Id": "string",
"ResultId": "string",
"Description": "string",
"Success": "boolean",
"MetricName": "string",
"MachineName": "string",
"IsCustomGoal": "string",
"Threshold": "double",
"Operator": "string",
"PassWhenGoalMet": "boolean",
"StopWhenGoalMet": "boolean"
},
"Metadata": "MetaData object"
}
GET
/Goals
GET goals via query. Note that this does NOT currently return attachments.
Returns the ENTIRE document including OID and Metadata, unless fields parameter or header is specified.
You may limit the number of goals returned by using the optional query parameter or header.
When used as a header the format is
Equality is via implication only:
You may limit the number of goals returned by using the optional query parameter or header.
When used as a header the format is
Query: { "Data.FieldToCompare" : "Value" }.Equality is via implication only:
{ "field": "value" } and the following operators are supported:$and, $ne, $gt, $lt, $gte, $lteExample operator usage:
Query:{
"Metadata.LastUpdate": {
"$gt": "2012-08-15"
}
}Parameters
/Goals?skip={skip}&take={take}&sortKeys={sortKeys}&schema={schema}&includeDeleted={includeDeleted}&query={query}&fields={fields}
skip
[Int32]
Starting point for paging. Defaults to 0.
take
[Int32]
End point for paging. Defaults to 100.
sortKeys
[String]
Comma seperated list of fields to sort the goal result set on. NOTE: Not implemented.
schema
[String]
Identifier for the object being stored.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted goals. Defaults to true.
query
[String]
Filter for goal result set. Query format:
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields
[String]
Filter to limit the fields returned on a goal. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata
Returns
An array of IStorageDataEntity objects
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of goal"
}HTTP Status
Reason
200
OK
400
Bad Request: Invalid arguments supplied.
GET
/Goals/{id}
GET a goal by id. This will return attachments.
Retrieves the full goal including attachments. When attachments are present the response's content type will be multipart/mixed.
Parameters
/Goals/{id}?includeDeleted={includeDeleted}
id
[String]
required
The identifier of the goal being retreived
includeDeleted
[Boolean]
Optional boolean indicating wheter to fetch deleted goals. Defaults to true.
Returns
IStorageDataEntity object:
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of goal"
}HTTP Status
Reason
200
OK
400
Bad Request: id parameter not supplied.
404
Not Found: goal does not exist.
410
Gone: goal is deleted when request supplies includeDeleted parameter as false.
POST
/Goals
Add a new goal (or goals) to the goal collection
The request body should contain the json representation of the goal or goals to add.
Example:
Attachments can be re-used (associated with multiple Json goals). When adding an attachment to a goal the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Key" : "NewValue", "Key2" : "NewValue2", ... } Note: This handles "bulk upload" of several goals with any number of associated attachments.Attachments can be re-used (associated with multiple Json goals). When adding an attachment to a goal the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of goal }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/Goals?schema={schema}&name={name}&parentId={parentId}
schema
[String]
Optional identifier for the goal being stored. This will be stored in the Metadata object of the created goal.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
name
[String]
Allows the inclusion of a name for metadata tagging (and Activity creation)
parentId
[String]
Allows the inclusion of a Parent Id for metadata tagging (and Activity creation)
Returns
201 Created. The response body will contain the created goal and the custom added Header contains the Meadata for the newly created goal in json format.
Example Added custom header:
Example Added custom header:
Added:{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
201
Created: goal succesfully created. Added Header contains the metadata for the newly created goal.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT
/Goals/{id}
Update a goal in the goal collection
The request body should contain the json representation of the goal to update.
Example:
Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a goal the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Data.Key" : "NewValue", "Data.Key2" : "NewValue2" }Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a goal the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of goal }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/Goals/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the goal to update
lastUpdate
[String]
required
The timestamp of last update for this goal.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK. The response body contains the updated goal and the custom Updated header contains the updated goal metadata.
Example custom Updated header:
Example custom Updated header:
Updated:{
"UpdatedDocuments": [
{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:14:16.0482808Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}
]
}HTTP Status
Reason
200
OK. Updated header will contain metadata for updated goal.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: goal has been previously deleted.
409
Conflict: lastUpdate does not match goal's last updated timestamp.
DELETE
/Goals/{id}
Remove a goal from the goal collection
Note: this does not perform a hard delete. The goal is tombstoned in the collection.
Parameters
/Goals/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the goal to remove.
lastUpdate
[String]
required
The timestamp of last update for this goal.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: goal has been previously deleted.
409
Conflict: lastUpdate does not match goal's last updated timestamp.
Feedback
Feedback collection
Feedback is only used by the IOS application and web portal.
Example:
Feedback is only used by the IOS application and web portal.
Example:
{
"Data": {
"Application": "string",
"Description": "string",
"Device": "string",
"OS": "string",
"Tags": "array of strings",
"Title": "string"
},
"Metadata": "Metadata object"
}
GET
/Feedback
GET feedback via query. Note that this does NOT currently return attachments.
Returns the ENTIRE document including OID and Metadata, unless fields parameter or header is specified.
You may limit the number of feedback returned by using the optional query parameter or header.
When used as a header the format is
Equality is via implication only:
You may limit the number of feedback returned by using the optional query parameter or header.
When used as a header the format is
Query: { "Data.FieldToCompare" : "Value" }.Equality is via implication only:
{ "field": "value" } and the following operators are supported:$and, $ne, $gt, $lt, $gte, $lteExample operator usage:
Query:{
"Metadata.LastUpdate": {
"$gt": "2012-08-15"
}
}Parameters
/Feedback?skip={skip}&take={take}&sortKeys={sortKeys}&schema={schema}&includeDeleted={includeDeleted}&query={query}&fields={fields}
skip
[Int32]
Starting point for paging. Defaults to 0.
take
[Int32]
End point for paging. Defaults to 100.
sortKeys
[String]
Comma seperated list of fields to sort the feedback result set on. NOTE: Not implemented.
schema
[String]
Identifier for the object being stored.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted feedback. Defaults to true.
query
[String]
Filter for feedback result set. Query format:
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields
[String]
Filter to limit the fields returned on a feedback. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata
Returns
An array of IStorageDataEntity objects
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of feedback"
}HTTP Status
Reason
200
OK
400
Bad Request: Invalid arguments supplied.
GET
/Feedback/{id}
GET a feedback by id. This will return attachments.
Retrieves the full feedback including attachments. When attachments are present the response's content type will be multipart/mixed.
Parameters
/Feedback/{id}?includeDeleted={includeDeleted}
id
[String]
required
The identifier of the feedback being retreived
includeDeleted
[Boolean]
Optional boolean indicating wheter to fetch deleted feedback. Defaults to true.
Returns
IStorageDataEntity object:
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of feedback"
}HTTP Status
Reason
200
OK
400
Bad Request: id parameter not supplied.
404
Not Found: feedback does not exist.
410
Gone: feedback is deleted when request supplies includeDeleted parameter as false.
POST
/Feedback
Add a new feedback (or feedback) to the feedback collection
The request body should contain the json representation of the feedback or feedback to add.
Example:
Attachments can be re-used (associated with multiple Json feedback). When adding an attachment to a feedback the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Key" : "NewValue", "Key2" : "NewValue2", ... } Note: This handles "bulk upload" of several feedback with any number of associated attachments.Attachments can be re-used (associated with multiple Json feedback). When adding an attachment to a feedback the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of feedback }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/Feedback?schema={schema}&name={name}&parentId={parentId}
schema
[String]
Optional identifier for the feedback being stored. This will be stored in the Metadata object of the created feedback.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
name
[String]
Allows the inclusion of a name for metadata tagging (and Activity creation)
parentId
[String]
Allows the inclusion of a Parent Id for metadata tagging (and Activity creation)
Returns
201 Created. The response body will contain the created feedback and the custom added Header contains the Meadata for the newly created feedback in json format.
Example Added custom header:
Example Added custom header:
Added:{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
201
Created: feedback succesfully created. Added Header contains the metadata for the newly created feedback.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT
/Feedback/{id}
Update a feedback in the feedback collection
The request body should contain the json representation of the feedback to update.
Example:
Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a feedback the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Data.Key" : "NewValue", "Data.Key2" : "NewValue2" }Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a feedback the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of feedback }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/Feedback/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the feedback to update
lastUpdate
[String]
required
The timestamp of last update for this feedback.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK. The response body contains the updated feedback and the custom Updated header contains the updated feedback metadata.
Example custom Updated header:
Example custom Updated header:
Updated:{
"UpdatedDocuments": [
{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:14:16.0482808Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}
]
}HTTP Status
Reason
200
OK. Updated header will contain metadata for updated feedback.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: feedback has been previously deleted.
409
Conflict: lastUpdate does not match feedback's last updated timestamp.
DELETE
/Feedback/{id}
Remove a feedback from the feedback collection
Note: this does not perform a hard delete. The feedback is tombstoned in the collection.
Parameters
/Feedback/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the feedback to remove.
lastUpdate
[String]
required
The timestamp of last update for this feedback.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: feedback has been previously deleted.
409
Conflict: lastUpdate does not match feedback's last updated timestamp.
Results
Results Collection The collection contains multiple types of results. ArtOfTest.WebAii.Design.Execution.RunResult, ArtOfTest.WebAii.Design.Execution.Profiler.ResultsFileXmlRoot
GET
/Results
GET results via query. Note that this does NOT currently return attachments.
Returns the ENTIRE document including OID and Metadata, unless fields parameter or header is specified.
You may limit the number of results returned by using the optional query parameter or header.
When used as a header the format is
Equality is via implication only:
You may limit the number of results returned by using the optional query parameter or header.
When used as a header the format is
Query: { "Data.FieldToCompare" : "Value" }.Equality is via implication only:
{ "field": "value" } and the following operators are supported:$and, $ne, $gt, $lt, $gte, $lteExample operator usage:
Query:{
"Metadata.LastUpdate": {
"$gt": "2012-08-15"
}
}Parameters
/Results?skip={skip}&take={take}&sortKeys={sortKeys}&schema={schema}&includeDeleted={includeDeleted}&query={query}&fields={fields}
skip
[Int32]
Starting point for paging. Defaults to 0.
take
[Int32]
End point for paging. Defaults to 100.
sortKeys
[String]
Comma seperated list of fields to sort the result result set on. NOTE: Not implemented.
schema
[String]
Identifier for the object being stored.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted results. Defaults to true.
query
[String]
Filter for result result set. Query format:
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields
[String]
Filter to limit the fields returned on a result. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata
Returns
An array of IStorageDataEntity objects
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of result"
}HTTP Status
Reason
200
OK
400
Bad Request: Invalid arguments supplied.
GET
/Results/{id}
GET a result by id. This will return attachments.
Retrieves the full result including attachments. When attachments are present the response's content type will be multipart/mixed.
Parameters
/Results/{id}?includeDeleted={includeDeleted}
id
[String]
required
The identifier of the result being retreived
includeDeleted
[Boolean]
Optional boolean indicating wheter to fetch deleted results. Defaults to true.
Returns
IStorageDataEntity object:
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of result"
}HTTP Status
Reason
200
OK
400
Bad Request: id parameter not supplied.
404
Not Found: result does not exist.
410
Gone: result is deleted when request supplies includeDeleted parameter as false.
POST
/Results
Add a new result (or results) to the result collection
The request body should contain the json representation of the result or results to add.
Example:
Attachments can be re-used (associated with multiple Json results). When adding an attachment to a result the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Key" : "NewValue", "Key2" : "NewValue2", ... } Note: This handles "bulk upload" of several results with any number of associated attachments.Attachments can be re-used (associated with multiple Json results). When adding an attachment to a result the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of result }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/Results?schema={schema}&name={name}&parentId={parentId}
schema
[String]
Optional identifier for the result being stored. This will be stored in the Metadata object of the created result.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
name
[String]
Allows the inclusion of a name for metadata tagging (and Activity creation)
parentId
[String]
Allows the inclusion of a Parent Id for metadata tagging (and Activity creation)
Returns
201 Created. The response body will contain the created result and the custom added Header contains the Meadata for the newly created result in json format.
Example Added custom header:
Example Added custom header:
Added:{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
201
Created: result succesfully created. Added Header contains the metadata for the newly created result.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT
/Results/{id}
Update a result in the result collection
The request body should contain the json representation of the result to update.
Example:
Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a result the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Data.Key" : "NewValue", "Data.Key2" : "NewValue2" }Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a result the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of result }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/Results/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the result to update
lastUpdate
[String]
required
The timestamp of last update for this result.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK. The response body contains the updated result and the custom Updated header contains the updated result metadata.
Example custom Updated header:
Example custom Updated header:
Updated:{
"UpdatedDocuments": [
{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:14:16.0482808Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}
]
}HTTP Status
Reason
200
OK. Updated header will contain metadata for updated result.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: lastUpdate does not match result's last updated timestamp.
409
Conflict: result has been previously deleted.
DELETE
/Results/{id}
Remove a result from the result collection
Note: this does not perform a hard delete. The result is tombstoned in the collection.
Parameters
/Results/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the result to remove.
lastUpdate
[String]
required
The timestamp of last update for this result.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: lastUpdate does not match result's last updated timestamp.
409
Conflict: result has been previously deleted.
ServiceVersion
Projects
Projects ArtOfTest.WebAii.Design.ProjectModel.Project Collection
Projects are containers for TestStudio tests and testlists.
Example:
Projects are containers for TestStudio tests and testlists.
Example:
{
"Data": {
"__type": "ArtOfTest.WebAii.Design.ProjectModel.Project",
"__value": {
"Id": "string",
"Name": "string",
"UserSettings": "ArtOfTest.WebAii.Design.UserSettings"
}
},
"Metadata": "MetaData object"
}
GET
/Projects
GET projects via query. Note that this does NOT currently return attachments.
Returns the ENTIRE document including OID and Metadata, unless fields parameter or header is specified.
You may limit the number of projects returned by using the optional query parameter or header.
When used as a header the format is
Equality is via implication only:
You may limit the number of projects returned by using the optional query parameter or header.
When used as a header the format is
Query: { "Data.FieldToCompare" : "Value" }.Equality is via implication only:
{ "field": "value" } and the following operators are supported:$and, $ne, $gt, $lt, $gte, $lteExample operator usage:
Query:{
"Metadata.LastUpdate": {
"$gt": "2012-08-15"
}
}Parameters
/Projects?skip={skip}&take={take}&sortKeys={sortKeys}&schema={schema}&includeDeleted={includeDeleted}&query={query}&fields={fields}
skip
[Int32]
Starting point for paging. Defaults to 0.
take
[Int32]
End point for paging. Defaults to 100.
sortKeys
[String]
Comma seperated list of fields to sort the project result set on. NOTE: Not implemented.
schema
[String]
Identifier for the object being stored.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted projects. Defaults to true.
query
[String]
Filter for project result set. Query format:
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields
[String]
Filter to limit the fields returned on a project. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata
Returns
An array of IStorageDataEntity objects
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of project"
}HTTP Status
Reason
200
OK
400
Bad Request: Invalid arguments supplied.
GET
/Projects/{id}
GET a project by id. This will return attachments.
Retrieves the full project including attachments. When attachments are present the response's content type will be multipart/mixed.
Parameters
/Projects/{id}?includeDeleted={includeDeleted}
id
[String]
required
The identifier of the project being retreived
includeDeleted
[Boolean]
Optional boolean indicating wheter to fetch deleted projects. Defaults to true.
Returns
IStorageDataEntity object:
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of project"
}HTTP Status
Reason
200
OK
400
Bad Request: id parameter not supplied.
404
Not Found: project does not exist.
410
Gone: project is deleted when request supplies includeDeleted parameter as false.
POST
/Projects
Add a new project (or projects) to the project collection
The request body should contain the json representation of the project or projects to add.
Example:
Attachments can be re-used (associated with multiple Json projects). When adding an attachment to a project the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Key" : "NewValue", "Key2" : "NewValue2", ... } Note: This handles "bulk upload" of several projects with any number of associated attachments.Attachments can be re-used (associated with multiple Json projects). When adding an attachment to a project the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of project }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/Projects?schema={schema}&name={name}&parentId={parentId}
schema
[String]
Optional identifier for the project being stored. This will be stored in the Metadata object of the created project.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
name
[String]
Allows the inclusion of a name for metadata tagging (and Activity creation)
parentId
[String]
Allows the inclusion of a Parent Id for metadata tagging (and Activity creation)
Returns
201 Created. The response body will contain the created project and the custom added Header contains the Meadata for the newly created project in json format.
Example Added custom header:
Example Added custom header:
Added:{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
201
Created: project succesfully created. Added Header contains the metadata for the newly created project.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT
/Projects/{id}
Update a project in the project collection
The request body should contain the json representation of the project to update.
Example:
Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a project the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Data.Key" : "NewValue", "Data.Key2" : "NewValue2" }Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a project the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of project }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/Projects/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the project to update
lastUpdate
[String]
required
The timestamp of last update for this project.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK. The response body contains the updated project and the custom Updated header contains the updated project metadata.
Example custom Updated header:
Example custom Updated header:
Updated:{
"UpdatedDocuments": [
{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:14:16.0482808Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}
]
}HTTP Status
Reason
200
OK. Updated header will contain metadata for updated project.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: lastUpdate does not match project's last updated timestamp.
409
Conflict: project has been previously deleted.
DELETE
/Projects/{id}
Remove a project from the project collection
Note: this does not perform a hard delete. The project is tombstoned in the collection.
Parameters
/Projects/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the project to remove.
lastUpdate
[String]
required
The timestamp of last update for this project.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: lastUpdate does not match project's last updated timestamp.
409
Conflict: project has been previously deleted.
Files
Files collection
Binary files that are attachments to other objects, Test, TestList, Comment, etc...
Binary files that are attachments to other objects, Test, TestList, Comment, etc...
GET
/Files
GET files metadata.
Parameters
/Files?includeDeleted={includeDeleted}
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted files. Defaults to true.
Returns
200 OK. The response body contains an array of file metatada objects.
Example:
Example:
{
"_id": "9c25f2d9-bcc0-41b0-877d-0a380d1e5a96",
"LastUpdate": "2013-06-13T20:24:13.48",
"Metadata": {
"Deleted": false,
"LastUpdate": "2013-06-13T20:24:13.48",
"LastUpdatedBy": "storageservice",
"ContentId": ""
}
}
GET
/Files/{id}
GET a file by id.
Parameters
/Files/{id}?includeDeleted={includeDeleted}
id
[String]
required
file unique identifier
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted files. Defaults to true.
Returns
200 OK. The response is multipart/mixed containing the file requested. A custom Metadata header cotains the file's metadata.
Example Metadata header:
Example Metadata header:
Metadata: {
"Deleted": false,
"LastUpdate": "2013-06-13T20:24:13.48",
"LastUpdatedBy": "storageservice",
"ContentId": ""
}
POST
/Files
Adds a file to the files collection
Expects a file in the request body and the appropriate Content-Type header.
Parameters
/Files?name={name}
name
[String]
Name of the file being created.
Returns
201 Created. The custom Added header contains the updated file metadata.
Example Added custom header:
Example Added custom header:
Added: {
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
200
OK. Added header will contain metadata for updated file.
400
Bad Request: name parameter is not supplied.
400
Bad Requst: Request body does not contain a file.
PUT
/Files/{id}
Update an existing file
Expects a file in the body of request.
Parameters
/Files/{id}?lastUpdate={lastUpdate}
id
[String]
required
id of file to update
lastUpdate
[String]
required
timestamp of last update for this file.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
201 Created. The custom Added header contains the updated file metadata.
Example Added custom header:
Example Added custom header:
Added:{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
201
Created. Added header will contain metadata for updated file.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
400
Bad Requst: Content-Type header media type does not match request content.
400
Bad Requst: Content-Type header not set.
400
Bad Requst: Request body does not contain a file.
409
Conflict: file has been previously deleted.
409
Conflict: lastUpdate does not match file's last updated timestamp.
DELETE
/Files/{id}
Remove a file from the files collection.
Note: this does not perform a hard delete. The file is tombstoned in the collection.
Parameters
/Files/{id}?lastUpdate={lastUpdate}
id
[String]
required
identifier of the file to remove.
lastUpdate
[String]
required
timestamp of last update for the file.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: file has been previously deleted.
409
Conflict: lastUpdate does not match file's last updated timestamp.
TestListResults
TestListResults Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport Collection
TestListResults contain basic data about the result of a TestList run.
Example:
TestListResults contain basic data about the result of a TestList run.
Example:
{
"Data": {
"EndTime": "ISO-8601 UTC date string",
"ExpectedTestCount": "integer",
"Id": "string",
"IsFinished": "boolean",
"ProjectId": "string",
"StartTime": "ISO-8601 UTC date string",
"TestListId": "string",
"TestListName": "string"
},
"Metadata": "MetaData object"
}
GET
/TestListResults
GET testlistresults via query. Note that this does NOT currently return attachments.
Returns the ENTIRE document including OID and Metadata, unless fields parameter or header is specified.
You may limit the number of testlistresults returned by using the optional query parameter or header.
When used as a header the format is
Equality is via implication only:
You may limit the number of testlistresults returned by using the optional query parameter or header.
When used as a header the format is
Query: { "Data.FieldToCompare" : "Value" }.Equality is via implication only:
{ "field": "value" } and the following operators are supported:$and, $ne, $gt, $lt, $gte, $lteExample operator usage:
Query:{
"Metadata.LastUpdate": {
"$gt": "2012-08-15"
}
}Parameters
/TestListResults?skip={skip}&take={take}&sortKeys={sortKeys}&schema={schema}&includeDeleted={includeDeleted}&query={query}&fields={fields}
skip
[Int32]
Starting point for paging. Defaults to 0.
take
[Int32]
End point for paging. Defaults to 100.
sortKeys
[String]
Comma seperated list of fields to sort the testlistresult result set on. NOTE: Not implemented.
schema
[String]
Identifier for the object being stored.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted testlistresults. Defaults to true.
query
[String]
Filter for testlistresult result set. Query format:
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields
[String]
Filter to limit the fields returned on a testlistresult. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata
Returns
An array of IStorageDataEntity objects
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of testlistresult"
}HTTP Status
Reason
200
OK
400
Bad Request: Invalid arguments supplied.
GET
/TestListResults/{id}
GET a testlistresult by id. This will return attachments.
Retrieves the full testlistresult including attachments. When attachments are present the response's content type will be multipart/mixed.
Parameters
/TestListResults/{id}?includeDeleted={includeDeleted}
id
[String]
required
The identifier of the testlistresult being retreived
includeDeleted
[Boolean]
Optional boolean indicating wheter to fetch deleted testlistresults. Defaults to true.
Returns
IStorageDataEntity object:
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of testlistresult"
}HTTP Status
Reason
200
OK
400
Bad Request: id parameter not supplied.
404
Not Found: testlistresult does not exist.
410
Gone: testlistresult is deleted when request supplies includeDeleted parameter as false.
POST
/TestListResults
Add a new testlistresult (or testlistresults) to the testlistresult collection
The request body should contain the json representation of the testlistresult or testlistresults to add.
Example:
Attachments can be re-used (associated with multiple Json testlistresults). When adding an attachment to a testlistresult the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Key" : "NewValue", "Key2" : "NewValue2", ... } Note: This handles "bulk upload" of several testlistresults with any number of associated attachments.Attachments can be re-used (associated with multiple Json testlistresults). When adding an attachment to a testlistresult the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of testlistresult }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/TestListResults?schema={schema}&name={name}&parentId={parentId}
schema
[String]
Optional identifier for the testlistresult being stored. This will be stored in the Metadata object of the created testlistresult.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
name
[String]
Allows the inclusion of a name for metadata tagging (and Activity creation)
parentId
[String]
Allows the inclusion of a Parent Id for metadata tagging (and Activity creation)
Returns
201 Created. The response body will contain the created testlistresult and the custom added Header contains the Meadata for the newly created testlistresult in json format.
Example Added custom header:
Example Added custom header:
Added:{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
201
Created: testlistresult succesfully created. Added Header contains the metadata for the newly created testlistresult.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT
/TestListResults/{id}
Update a testlistresult in the testlistresult collection
The request body should contain the json representation of the testlistresult to update.
Example:
Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a testlistresult the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Data.Key" : "NewValue", "Data.Key2" : "NewValue2" }Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a testlistresult the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of testlistresult }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/TestListResults/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the testlistresult to update
lastUpdate
[String]
required
The timestamp of last update for this testlistresult.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK. The response body contains the updated testlistresult and the custom Updated header contains the updated testlistresult metadata.
Example custom Updated header:
Example custom Updated header:
Updated:{
"UpdatedDocuments": [
{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:14:16.0482808Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}
]
}HTTP Status
Reason
200
OK. Updated header will contain metadata for updated testlistresult.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: lastUpdate does not match testlistresult's last updated timestamp.
409
Conflict: testlistresult has been previously deleted.
DELETE
/TestListResults/{id}
Remove a testlistresult from the testlistresult collection
Note: this does not perform a hard delete. The testlistresult is tombstoned in the collection.
Parameters
/TestListResults/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the testlistresult to remove.
lastUpdate
[String]
required
The timestamp of last update for this testlistresult.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: lastUpdate does not match testlistresult's last updated timestamp.
409
Conflict: testlistresult has been previously deleted.
TestLists
TestLists ArtOfTest.WebAii.Design.Execution.TestList Collection
TestLists are containers for a group of Tests.
TestLists are containers for a group of Tests.
GET
/TestLists
GET testlists via query. Note that this does NOT currently return attachments.
Returns the ENTIRE document including OID and Metadata, unless fields parameter or header is specified.
You may limit the number of testlists returned by using the optional query parameter or header.
When used as a header the format is
Equality is via implication only:
You may limit the number of testlists returned by using the optional query parameter or header.
When used as a header the format is
Query: { "Data.FieldToCompare" : "Value" }.Equality is via implication only:
{ "field": "value" } and the following operators are supported:$and, $ne, $gt, $lt, $gte, $lteExample operator usage:
Query:{
"Metadata.LastUpdate": {
"$gt": "2012-08-15"
}
}Parameters
/TestLists?skip={skip}&take={take}&sortKeys={sortKeys}&schema={schema}&includeDeleted={includeDeleted}&query={query}&fields={fields}
skip
[Int32]
Starting point for paging. Defaults to 0.
take
[Int32]
End point for paging. Defaults to 100.
sortKeys
[String]
Comma seperated list of fields to sort the testlist result set on. NOTE: Not implemented.
schema
[String]
Identifier for the object being stored.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted testlists. Defaults to true.
query
[String]
Filter for testlist result set. Query format:
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields
[String]
Filter to limit the fields returned on a testlist. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata
Returns
An array of IStorageDataEntity objects
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of testlist"
}HTTP Status
Reason
200
OK
400
Bad Request: Invalid arguments supplied.
GET
/TestLists/{id}
GET a testlist by id. This will return attachments.
Retrieves the full testlist including attachments. When attachments are present the response's content type will be multipart/mixed.
Parameters
/TestLists/{id}?includeDeleted={includeDeleted}
id
[String]
required
The identifier of the testlist being retreived
includeDeleted
[Boolean]
Optional boolean indicating wheter to fetch deleted testlists. Defaults to true.
Returns
IStorageDataEntity object:
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of testlist"
}HTTP Status
Reason
200
OK
400
Bad Request: id parameter not supplied.
404
Not Found: testlist does not exist.
410
Gone: testlist is deleted when request supplies includeDeleted parameter as false.
POST
/TestLists
Add a new testlist (or testlists) to the testlist collection
The request body should contain the json representation of the testlist or testlists to add.
Example:
Attachments can be re-used (associated with multiple Json testlists). When adding an attachment to a testlist the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Key" : "NewValue", "Key2" : "NewValue2", ... } Note: This handles "bulk upload" of several testlists with any number of associated attachments.Attachments can be re-used (associated with multiple Json testlists). When adding an attachment to a testlist the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of testlist }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/TestLists?schema={schema}&name={name}&parentId={parentId}
schema
[String]
Optional identifier for the testlist being stored. This will be stored in the Metadata object of the created testlist.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
name
[String]
Allows the inclusion of a name for metadata tagging (and Activity creation)
parentId
[String]
Allows the inclusion of a Parent Id for metadata tagging (and Activity creation)
Returns
201 Created. The response body will contain the created testlist and the custom added Header contains the Meadata for the newly created testlist in json format.
Example Added custom header:
Example Added custom header:
Added:{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
201
Created: testlist succesfully created. Added Header contains the metadata for the newly created testlist.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT
/TestLists/{id}
Update a testlist in the testlist collection
The request body should contain the json representation of the testlist to update.
Example:
Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a testlist the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Data.Key" : "NewValue", "Data.Key2" : "NewValue2" }Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a testlist the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of testlist }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/TestLists/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the testlist to update
lastUpdate
[String]
required
The timestamp of last update for this testlist.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK. The response body contains the updated testlist and the custom Updated header contains the updated testlist metadata.
Example custom Updated header:
Example custom Updated header:
Updated:{
"UpdatedDocuments": [
{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:14:16.0482808Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}
]
}HTTP Status
Reason
200
OK. Updated header will contain metadata for updated testlist.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: lastUpdate does not match testlist's last updated timestamp.
409
Conflict: testlist has been previously deleted.
DELETE
/TestLists/{id}
Remove a testlist from the testlist collection
Note: this does not perform a hard delete. The testlist is tombstoned in the collection.
Parameters
/TestLists/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the testlist to remove.
lastUpdate
[String]
required
The timestamp of last update for this testlist.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: lastUpdate does not match testlist's last updated timestamp.
409
Conflict: testlist has been previously deleted.
Tests
Tests Collection
The collection contains multiple types of tests: web test ArtOfTest.WebAii.Design.ProjectModel.Test and load test Telerik.TestStudio.Load.LoadDesignTest
The collection contains multiple types of tests: web test ArtOfTest.WebAii.Design.ProjectModel.Test and load test Telerik.TestStudio.Load.LoadDesignTest
GET
/Tests
GET tests via query. Note that this does NOT currently return attachments.
Returns the ENTIRE document including OID and Metadata, unless fields parameter or header is specified.
You may limit the number of tests returned by using the optional query parameter or header.
When used as a header the format is
Equality is via implication only:
You may limit the number of tests returned by using the optional query parameter or header.
When used as a header the format is
Query: { "Data.FieldToCompare" : "Value" }.Equality is via implication only:
{ "field": "value" } and the following operators are supported:$and, $ne, $gt, $lt, $gte, $lteExample operator usage:
Query:{
"Metadata.LastUpdate": {
"$gt": "2012-08-15"
}
}Parameters
/Tests?skip={skip}&take={take}&sortKeys={sortKeys}&schema={schema}&includeDeleted={includeDeleted}&query={query}&fields={fields}
skip
[Int32]
Starting point for paging. Defaults to 0.
take
[Int32]
End point for paging. Defaults to 100.
sortKeys
[String]
Comma seperated list of fields to sort the test result set on. NOTE: Not implemented.
schema
[String]
Identifier for the object being stored.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
includeDeleted
[Boolean]
Boolean indicating wheter to fetch deleted tests. Defaults to true.
query
[String]
Filter for test result set. Query format:
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields
[String]
Filter to limit the fields returned on a test. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata
Returns
An array of IStorageDataEntity objects
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of test"
}HTTP Status
Reason
200
OK
400
Bad Request: Invalid arguments supplied.
GET
/Tests/{id}
GET a test by id. This will return attachments.
Retrieves the full test including attachments. When attachments are present the response's content type will be multipart/mixed.
Parameters
/Tests/{id}?includeDeleted={includeDeleted}
id
[String]
required
The identifier of the test being retreived
includeDeleted
[Boolean]
Optional boolean indicating wheter to fetch deleted tests. Defaults to true.
Returns
IStorageDataEntity object:
{
"Id": "string",
"Metadata": "IStorageDataMetadata",
"Data": "json representaion of test"
}HTTP Status
Reason
200
OK
400
Bad Request: id parameter not supplied.
404
Not Found: test does not exist.
410
Gone: test is deleted when request supplies includeDeleted parameter as false.
POST
/Tests
Add a new test (or tests) to the test collection
The request body should contain the json representation of the test or tests to add.
Example:
Attachments can be re-used (associated with multiple Json tests). When adding an attachment to a test the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Key" : "NewValue", "Key2" : "NewValue2", ... } Note: This handles "bulk upload" of several tests with any number of associated attachments.Attachments can be re-used (associated with multiple Json tests). When adding an attachment to a test the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of test }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/Tests?schema={schema}&name={name}&parentId={parentId}
schema
[String]
Optional identifier for the test being stored. This will be stored in the Metadata object of the created test.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
name
[String]
Allows the inclusion of a name for metadata tagging (and Activity creation)
parentId
[String]
Allows the inclusion of a Parent Id for metadata tagging (and Activity creation)
Returns
201 Created. The response body will contain the created test and the custom added Header contains the Meadata for the newly created test in json format.
Example Added custom header:
Example Added custom header:
Added:{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:00:18.336Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}HTTP Status
Reason
201
Created: test succesfully created. Added Header contains the metadata for the newly created test.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT
/Tests/{id}
Update a test in the test collection
The request body should contain the json representation of the test to update.
Example:
Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a test the request content type must be set to Content-Type: multipart/mixed.
Example:
Example:
{ "Data.Key" : "NewValue", "Data.Key2" : "NewValue2" }Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a test the request content type must be set to Content-Type: multipart/mixed.
Example:
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: application/json; charset=utf-8
{ Json representation of test }
--4c90d0f5-e0b0-4806-b9a1-214c3513b60d
Content-Type: multipart/mixed
Content-Disposition: attachment; filename="name.extension"
file data
Parameters
/Tests/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the test to update
lastUpdate
[String]
required
The timestamp of last update for this test.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK. The response body contains the updated test and the custom Updated header contains the updated test metadata.
Example custom Updated header:
Example custom Updated header:
Updated:{
"UpdatedDocuments": [
{
"Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
"Metadata": {
"Name": null,
"ParentId": null,
"LastUpdate": "2013-06-17T15:14:16.0482808Z",
"LastUpdatedBy": "storageservice",
"Schema": "",
"Deleted": false,
"AttachmentIds": null,
"Tag": null
},
"Data": null
}
]
}HTTP Status
Reason
200
OK. Updated header will contain metadata for updated test.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: lastUpdate does not match test's last updated timestamp.
409
Conflict: test has been previously deleted.
DELETE
/Tests/{id}
Remove a test from the test collection
Note: this does not perform a hard delete. The test is tombstoned in the collection.
Parameters
/Tests/{id}?lastUpdate={lastUpdate}
id
[String]
required
The identifier of the test to remove.
lastUpdate
[String]
required
The timestamp of last update for this test.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)
Returns
200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: lastUpdate does not match test's last updated timestamp.
409
Conflict: test has been previously deleted.